Skip to content

Add Workers for Platforms bindings documentation #22975

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Aug 4, 2025
Merged

Add Workers for Platforms bindings documentation #22975

merged 5 commits into from
Aug 4, 2025

Conversation

@dinasaur404
Copy link
Contributor

@dinasaur404 dinasaur404 commented Jun 9, 2025

Summary

Adding a new page to the Workers for Platforms docs to document how platform customers can add bindings to user workers.

Screenshots (optional)

Screenshot 2025-06-09 at 5 45 05 PM

Documentation checklist

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Jun 9, 2025 •
edited
Loading

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

PR Change Summary

Added a new documentation page for Workers for Platforms, detailing how platform customers can add bindings to user workers.

  • Introduced a new page on bindings for User Workers in the Workers for Platforms documentation.
  • Explained how to create and attach various resource bindings like KV, D1, and R2 to User Workers.
  • Provided examples of API requests and Wrangler configurations for adding bindings.

Added Files

  • src/content/docs/cloudflare-for-platforms/workers-for-platforms/get-started/bindings.mdx
How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

windsurf-bot[bot]
windsurf-bot bot reviewed Jun 9, 2025
View reviewed changes
Copy link
Contributor

@windsurf-bot windsurf-bot bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 To request another review, post a new comment with "/windsurf-review".

src/content/docs/cloudflare-for-platforms/workers-for-platforms/get-started/bindings.mdx Outdated

#### Using the API

Use the [Upload User Worker API](http://localhost:1111/api/resources/workers_for_platforms/subresources/dispatch/subresources/namespaces/subresources/scripts/methods/update/) to attach bindings to a Worker. You can do this when you're first uploading the Worker script or when updating an existing Worker.
Copy link
Contributor

@windsurf-bot windsurf-bot bot Jun 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The API link is pointing to a localhost URL which won't work for users. This should be replaced with the actual production URL.

Suggested change
Use the [Upload User Worker API](http://localhost:1111/api/resources/workers_for_platforms/subresources/dispatch/subresources/namespaces/subresources/scripts/methods/update/) to attach bindings to a Worker. You can do this when you're first uploading the Worker script or when updating an existing Worker.
Use the [Upload User Worker API](/api/resources/workers_for_platforms/subresources/dispatch/subresources/namespaces/subresources/scripts/methods/update/) to attach bindings to a Worker. You can do this when you're first uploading the Worker script or when updating an existing Worker.

dinasaur404 and others added 3 commits June 9, 2025 17:46
@dinasaur404
Update bindings.mdx
342ccb8 
Remove localhost reference
@dinasaur404 @windsurf-bot
Update src/content/docs/cloudflare-for-platforms/workers-for-platform…
6fe9f3c 
…s/get-started/bindings.mdx

Co-authored-by: windsurf-bot[bot] <189301087+windsurf-bot[bot]@users.noreply.github.com>
@dinasaur404 @windsurf-bot
Update src/content/docs/cloudflare-for-platforms/workers-for-platform…
d385b8d 
…s/get-started/bindings.mdx

Co-authored-by: windsurf-bot[bot] <189301087+windsurf-bot[bot]@users.noreply.github.com>
@github-actions
Copy link
Contributor

github-actions bot commented Jun 9, 2025 •
edited
Loading

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/cloudflare-for-platforms/workers-for-platforms/ @irvinebroque, @GregBrimble, @cloudflare/deploy-config, @cloudflare/pcx-technical-writing

@github-actions
Copy link
Contributor

github-actions bot commented Jun 9, 2025 •
edited
Loading

Preview URL: https://d9add4ee.preview.developers.cloudflare.com
Preview Branch URL: https://docs-wfp-bindings.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/get-started/bindings/ https://docs-wfp-bindings.preview.developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/get-started/bindings/
https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/get-started/user-workers/ https://docs-wfp-bindings.preview.developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/get-started/user-workers/

markdembo
markdembo suggested changes Jun 10, 2025
View reviewed changes
Copy link
Contributor

@markdembo markdembo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great addition, but needs some work imho

irvinebroque
irvinebroque requested changes Jun 11, 2025
View reviewed changes
@angelampcosta angelampcosta removed their assignment Jul 18, 2025
@dinasaur404 dinasaur404 requested a review from markdembo August 1, 2025 17:12
@irvinebroque irvinebroque enabled auto-merge (squash) August 1, 2025 17:12
@rita3ko rita3ko disabled auto-merge August 1, 2025 18:01
@rita3ko rita3ko self-requested a review August 1, 2025 18:58
@pedrosousa pedrosousa merged commit 68603e2 into production Aug 4, 2025
8 checks passed
@pedrosousa pedrosousa deleted the docs/wfp-bindings branch August 4, 2025 08:29
thomasgauvin pushed a commit that referenced this pull request Aug 15, 2025
@dinasaur404 @windsurf-bot @thomasgauvin
[C4Plat] Add Workers for Platforms bindings documentation (#22975)
0587b45 
---------

Co-authored-by: windsurf-bot[bot] <189301087+windsurf-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@irvinebroque irvinebroque irvinebroque approved these changes

@rita3ko rita3ko rita3ko approved these changes

@angelampcosta angelampcosta Awaiting requested review from angelampcosta

@GregBrimble GregBrimble Awaiting requested review from GregBrimble

+2 more reviewers

@windsurf-bot windsurf-bot[bot] windsurf-bot[bot] left review comments

@markdembo markdembo markdembo approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@irvinebroque irvinebroque

@GregBrimble GregBrimble

Labels

product:cloudflare-for-platforms size/m

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@dinasaur404 @irvinebroque @rita3ko @markdembo @pedrosousa @GregBrimble @angelampcosta